FHIR IG analytics| Package | smart.permission-tickets |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-PermissionTicket.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/jmandel/smart-permission-tickets-wip/StructureDefinition-PermissionTicket.html |
| URL | http://smarthealthit.org/ig/permission-tickets/StructureDefinition/PermissionTicket |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-03-31T14:15:50+00:00 |
| Name | PermissionTicket |
| Title | Permission Ticket (JWT Payload) |
| Description | Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type. |
| Type | http://smarthealthit.org/ig/permission-tickets/StructureDefinition/PermissionTicket |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition PermissionTicket
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PermissionTicket | 0..* | Base | Permission Ticket (JWT Payload) | |
  iss | 1..1 | string | Issuer (Trusted Issuer URL) | |
| sub | 1..1 | string | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. | |
| aud | 1..* | uri | Audience (recipient URL(s) or network / trust framework identifier) | |
| exp | 1..1 | integer | Expiration Timestamp | |
| iat | 0..1 | integer | Issued-At Timestamp | |
| jti | 0..1 | string | Unique Ticket ID | |
| ticket_type | 1..1 | uri | Ticket type URI identifying the ticket schema and processing rules | |
 cnf | 0..1 | BackboneElement | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. | |
  jkt | 1..1 | string | JWK Thumbprint (RFC 7638) of the authorized client key | |
| revocation | 0..1 | BackboneElement | Revocation Information | |
| url | 1..1 | url | URL of the Credential Revocation List (CRL) | |
| rid | 1..1 | string | Revocation Identifier (opaque, max 24 chars) | |
| authorization | 1..1 | BackboneElement | Common Authorization Claims | |
| subject | 1..1 | BackboneElement | The Patient or Subject of the data | |
| type | 1..1 | code | Subject resolution mode: match | identifier | reference | |
 traits | 0..1 | Patient | Demographic traits for matching (type=match) | |
| resourceType | 0..1 | string | Resource Type (e.g. Patient) | |
| @id | 0..1 | string | Local resource ID (type=reference) | |
| reference | 0..1 | string | Local resource reference, e.g. Patient/123 (type=reference) | |
| identifier | 0..* | Identifier | Business Identifier (type=identifier) | |
| access | 1..1 | BackboneElement | Access Constraints | |
| scopes | 0..* | string | SMART Scopes (e.g. patient/Immunization.rs) | |
| periods | 0..* | Period | Time restrictions (Service Date) | |
| jurisdictions | 0..* | Address | Jurisdictional restrictions (state/country granularity) | |
| organizations | 0..* | Organization | Source organization restrictions (matching by identifier preferred) | |
| requester | 0..1 | BackboneElement | The Requesting Agent (optional) | |
 resourceType | 1..1 | string | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) | |
| name | 0..* | HumanName | Name of the requester | |
| telecom | 0..* | ContactPoint | Contact details | |
| identifier | 0..* | Identifier | Requester identifiers (NPI, etc) | |
| relationship | 0..* | CodeableConcept | Relationship to subject | |
| type | 0..* | CodeableConcept | Organization type | |
| contained | 0..* | Resource | Embedded resources | |
| details | 0..1 | BackboneElement | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "PermissionTicket",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://smarthealthit.org/ig/permission-tickets/StructureDefinition/PermissionTicket",
"version": "0.1.0",
"name": "PermissionTicket",
"title": "Permission Ticket (JWT Payload)",
"status": "draft",
"date": "2026-03-31T14:15:50+00:00",
"description": "Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://smarthealthit.org/ig/permission-tickets/StructureDefinition/PermissionTicket",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "PermissionTicket",
"path": "PermissionTicket",
"short": "Permission Ticket (JWT Payload)",
"definition": "Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "PermissionTicket.iss",
"path": "PermissionTicket.iss",
"short": "Issuer (Trusted Issuer URL)",
"definition": "Issuer (Trusted Issuer URL)",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.iss",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.sub",
"path": "PermissionTicket.sub",
"short": "Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier.",
"definition": "Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier.",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.sub",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.aud",
"path": "PermissionTicket.aud",
"short": "Audience (recipient URL(s) or network / trust framework identifier)",
"definition": "Audience (recipient URL(s) or network / trust framework identifier)",
"min": 1,
"max": "*",
"base": {
"path": "PermissionTicket.aud",
"min": 1,
"max": "*"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "PermissionTicket.exp",
"path": "PermissionTicket.exp",
"short": "Expiration Timestamp",
"definition": "Expiration Timestamp",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.exp",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "PermissionTicket.iat",
"path": "PermissionTicket.iat",
"short": "Issued-At Timestamp",
"definition": "Issued-At Timestamp",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.iat",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "PermissionTicket.jti",
"path": "PermissionTicket.jti",
"short": "Unique Ticket ID",
"definition": "Unique Ticket ID",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.jti",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.ticket-type",
"path": "PermissionTicket.ticket_type",
"short": "Ticket type URI identifying the ticket schema and processing rules",
"definition": "Ticket type URI identifying the ticket schema and processing rules",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.ticket_type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "PermissionTicket.cnf",
"path": "PermissionTicket.cnf",
"short": "Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding.",
"definition": "Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding.",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.cnf",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.cnf.id",
"path": "PermissionTicket.cnf.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.cnf.extension",
"path": "PermissionTicket.cnf.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.cnf.modifierExtension",
"path": "PermissionTicket.cnf.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.cnf.jkt",
"path": "PermissionTicket.cnf.jkt",
"short": "JWK Thumbprint (RFC 7638) of the authorized client key",
"definition": "JWK Thumbprint (RFC 7638) of the authorized client key",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.cnf.jkt",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.revocation",
"path": "PermissionTicket.revocation",
"short": "Revocation Information",
"definition": "Revocation Information",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.revocation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.revocation.id",
"path": "PermissionTicket.revocation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.revocation.extension",
"path": "PermissionTicket.revocation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.revocation.modifierExtension",
"path": "PermissionTicket.revocation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.revocation.url",
"path": "PermissionTicket.revocation.url",
"short": "URL of the Credential Revocation List (CRL)",
"definition": "URL of the Credential Revocation List (CRL)",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.revocation.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "PermissionTicket.revocation.rid",
"path": "PermissionTicket.revocation.rid",
"short": "Revocation Identifier (opaque, max 24 chars)",
"definition": "Revocation Identifier (opaque, max 24 chars)",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.revocation.rid",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization",
"path": "PermissionTicket.authorization",
"short": "Common Authorization Claims",
"definition": "Common Authorization Claims",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.authorization",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.authorization.id",
"path": "PermissionTicket.authorization.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.extension",
"path": "PermissionTicket.authorization.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.modifierExtension",
"path": "PermissionTicket.authorization.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.authorization.subject",
"path": "PermissionTicket.authorization.subject",
"short": "The Patient or Subject of the data",
"definition": "The Patient or Subject of the data",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.authorization.subject.id",
"path": "PermissionTicket.authorization.subject.id",
"representation": [
"xmlAttr"
],
"short": "Local resource ID (type=reference)",
"definition": "Local resource ID (type=reference)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.subject.extension",
"path": "PermissionTicket.authorization.subject.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.subject.modifierExtension",
"path": "PermissionTicket.authorization.subject.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.authorization.subject.type",
"path": "PermissionTicket.authorization.subject.type",
"short": "Subject resolution mode: match | identifier | reference",
"definition": "Subject resolution mode: match | identifier | reference",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.subject.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "PermissionTicket.authorization.subject.traits",
"path": "PermissionTicket.authorization.subject.traits",
"short": "Demographic traits for matching (type=match)",
"definition": "Demographic traits for matching (type=match)",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.subject.traits",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Patient"
}
]
},
{
"id": "PermissionTicket.authorization.subject.resourceType",
"path": "PermissionTicket.authorization.subject.resourceType",
"short": "Resource Type (e.g. Patient)",
"definition": "Resource Type (e.g. Patient)",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.subject.resourceType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.subject.reference",
"path": "PermissionTicket.authorization.subject.reference",
"short": "Local resource reference, e.g. Patient/123 (type=reference)",
"definition": "Local resource reference, e.g. Patient/123 (type=reference)",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.subject.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.subject.identifier",
"path": "PermissionTicket.authorization.subject.identifier",
"short": "Business Identifier (type=identifier)",
"definition": "Business Identifier (type=identifier)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.subject.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PermissionTicket.authorization.access",
"path": "PermissionTicket.authorization.access",
"short": "Access Constraints",
"definition": "Access Constraints",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.access",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.authorization.access.id",
"path": "PermissionTicket.authorization.access.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.access.extension",
"path": "PermissionTicket.authorization.access.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.access.modifierExtension",
"path": "PermissionTicket.authorization.access.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.authorization.access.scopes",
"path": "PermissionTicket.authorization.access.scopes",
"short": "SMART Scopes (e.g. patient/Immunization.rs)",
"definition": "SMART Scopes (e.g. patient/Immunization.rs)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.access.scopes",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.access.periods",
"path": "PermissionTicket.authorization.access.periods",
"short": "Time restrictions (Service Date)",
"definition": "Time restrictions (Service Date)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.access.periods",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Period"
}
]
},
{
"id": "PermissionTicket.authorization.access.jurisdictions",
"path": "PermissionTicket.authorization.access.jurisdictions",
"short": "Jurisdictional restrictions (state/country granularity)",
"definition": "Jurisdictional restrictions (state/country granularity)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.access.jurisdictions",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Address"
}
]
},
{
"id": "PermissionTicket.authorization.access.organizations",
"path": "PermissionTicket.authorization.access.organizations",
"short": "Source organization restrictions (matching by identifier preferred)",
"definition": "Source organization restrictions (matching by identifier preferred)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.access.organizations",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Organization"
}
]
},
{
"id": "PermissionTicket.authorization.requester",
"path": "PermissionTicket.authorization.requester",
"short": "The Requesting Agent (optional)",
"definition": "The Requesting Agent (optional)",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.requester",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "PermissionTicket.authorization.requester.id",
"path": "PermissionTicket.authorization.requester.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.requester.extension",
"path": "PermissionTicket.authorization.requester.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PermissionTicket.authorization.requester.modifierExtension",
"path": "PermissionTicket.authorization.requester.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PermissionTicket.authorization.requester.resourceType",
"path": "PermissionTicket.authorization.requester.resourceType",
"short": "Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization)",
"definition": "Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization)",
"min": 1,
"max": "1",
"base": {
"path": "PermissionTicket.authorization.requester.resourceType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.requester.name",
"path": "PermissionTicket.authorization.requester.name",
"short": "Name of the requester",
"definition": "Name of the requester",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "HumanName"
}
]
},
{
"id": "PermissionTicket.authorization.requester.telecom",
"path": "PermissionTicket.authorization.requester.telecom",
"short": "Contact details",
"definition": "Contact details",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
]
},
{
"id": "PermissionTicket.authorization.requester.identifier",
"path": "PermissionTicket.authorization.requester.identifier",
"short": "Requester identifiers (NPI, etc)",
"definition": "Requester identifiers (NPI, etc)",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PermissionTicket.authorization.requester.relationship",
"path": "PermissionTicket.authorization.requester.relationship",
"short": "Relationship to subject",
"definition": "Relationship to subject",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.relationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PermissionTicket.authorization.requester.type",
"path": "PermissionTicket.authorization.requester.type",
"short": "Organization type",
"definition": "Organization type",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.type",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PermissionTicket.authorization.requester.contained",
"path": "PermissionTicket.authorization.requester.contained",
"short": "Embedded resources",
"definition": "Embedded resources",
"min": 0,
"max": "*",
"base": {
"path": "PermissionTicket.authorization.requester.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
]
},
{
"id": "PermissionTicket.details",
"path": "PermissionTicket.details",
"short": "Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims.",
"definition": "Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims.",
"min": 0,
"max": "1",
"base": {
"path": "PermissionTicket.details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
]
}
]
},
"differential": {
"element": [
{
"id": "PermissionTicket",
"path": "PermissionTicket",
"short": "Permission Ticket (JWT Payload)",
"definition": "Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type."
},
{
"id": "PermissionTicket.iss",
"path": "PermissionTicket.iss",
"short": "Issuer (Trusted Issuer URL)",
"definition": "Issuer (Trusted Issuer URL)",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.sub",
"path": "PermissionTicket.sub",
"short": "Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier.",
"definition": "Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.aud",
"path": "PermissionTicket.aud",
"short": "Audience (recipient URL(s) or network / trust framework identifier)",
"definition": "Audience (recipient URL(s) or network / trust framework identifier)",
"min": 1,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "PermissionTicket.exp",
"path": "PermissionTicket.exp",
"short": "Expiration Timestamp",
"definition": "Expiration Timestamp",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "PermissionTicket.iat",
"path": "PermissionTicket.iat",
"short": "Issued-At Timestamp",
"definition": "Issued-At Timestamp",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "PermissionTicket.jti",
"path": "PermissionTicket.jti",
"short": "Unique Ticket ID",
"definition": "Unique Ticket ID",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.ticket-type",
"path": "PermissionTicket.ticket_type",
"short": "Ticket type URI identifying the ticket schema and processing rules",
"definition": "Ticket type URI identifying the ticket schema and processing rules",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "PermissionTicket.cnf",
"path": "PermissionTicket.cnf",
"short": "Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding.",
"definition": "Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.cnf.jkt",
"path": "PermissionTicket.cnf.jkt",
"short": "JWK Thumbprint (RFC 7638) of the authorized client key",
"definition": "JWK Thumbprint (RFC 7638) of the authorized client key",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.revocation",
"path": "PermissionTicket.revocation",
"short": "Revocation Information",
"definition": "Revocation Information",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.revocation.url",
"path": "PermissionTicket.revocation.url",
"short": "URL of the Credential Revocation List (CRL)",
"definition": "URL of the Credential Revocation List (CRL)",
"min": 1,
"max": "1",
"type": [
{
"code": "url"
}
]
},
{
"id": "PermissionTicket.revocation.rid",
"path": "PermissionTicket.revocation.rid",
"short": "Revocation Identifier (opaque, max 24 chars)",
"definition": "Revocation Identifier (opaque, max 24 chars)",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization",
"path": "PermissionTicket.authorization",
"short": "Common Authorization Claims",
"definition": "Common Authorization Claims",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.authorization.subject",
"path": "PermissionTicket.authorization.subject",
"short": "The Patient or Subject of the data",
"definition": "The Patient or Subject of the data",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.authorization.subject.type",
"path": "PermissionTicket.authorization.subject.type",
"short": "Subject resolution mode: match | identifier | reference",
"definition": "Subject resolution mode: match | identifier | reference",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "PermissionTicket.authorization.subject.traits",
"path": "PermissionTicket.authorization.subject.traits",
"short": "Demographic traits for matching (type=match)",
"definition": "Demographic traits for matching (type=match)",
"min": 0,
"max": "1",
"type": [
{
"code": "Patient"
}
]
},
{
"id": "PermissionTicket.authorization.subject.resourceType",
"path": "PermissionTicket.authorization.subject.resourceType",
"short": "Resource Type (e.g. Patient)",
"definition": "Resource Type (e.g. Patient)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.subject.id",
"path": "PermissionTicket.authorization.subject.id",
"short": "Local resource ID (type=reference)",
"definition": "Local resource ID (type=reference)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.subject.reference",
"path": "PermissionTicket.authorization.subject.reference",
"short": "Local resource reference, e.g. Patient/123 (type=reference)",
"definition": "Local resource reference, e.g. Patient/123 (type=reference)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.subject.identifier",
"path": "PermissionTicket.authorization.subject.identifier",
"short": "Business Identifier (type=identifier)",
"definition": "Business Identifier (type=identifier)",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PermissionTicket.authorization.access",
"path": "PermissionTicket.authorization.access",
"short": "Access Constraints",
"definition": "Access Constraints",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.authorization.access.scopes",
"path": "PermissionTicket.authorization.access.scopes",
"short": "SMART Scopes (e.g. patient/Immunization.rs)",
"definition": "SMART Scopes (e.g. patient/Immunization.rs)",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.access.periods",
"path": "PermissionTicket.authorization.access.periods",
"short": "Time restrictions (Service Date)",
"definition": "Time restrictions (Service Date)",
"min": 0,
"max": "*",
"type": [
{
"code": "Period"
}
]
},
{
"id": "PermissionTicket.authorization.access.jurisdictions",
"path": "PermissionTicket.authorization.access.jurisdictions",
"short": "Jurisdictional restrictions (state/country granularity)",
"definition": "Jurisdictional restrictions (state/country granularity)",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
]
},
{
"id": "PermissionTicket.authorization.access.organizations",
"path": "PermissionTicket.authorization.access.organizations",
"short": "Source organization restrictions (matching by identifier preferred)",
"definition": "Source organization restrictions (matching by identifier preferred)",
"min": 0,
"max": "*",
"type": [
{
"code": "Organization"
}
]
},
{
"id": "PermissionTicket.authorization.requester",
"path": "PermissionTicket.authorization.requester",
"short": "The Requesting Agent (optional)",
"definition": "The Requesting Agent (optional)",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "PermissionTicket.authorization.requester.resourceType",
"path": "PermissionTicket.authorization.requester.resourceType",
"short": "Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization)",
"definition": "Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization)",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "PermissionTicket.authorization.requester.name",
"path": "PermissionTicket.authorization.requester.name",
"short": "Name of the requester",
"definition": "Name of the requester",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
]
},
{
"id": "PermissionTicket.authorization.requester.telecom",
"path": "PermissionTicket.authorization.requester.telecom",
"short": "Contact details",
"definition": "Contact details",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
]
},
{
"id": "PermissionTicket.authorization.requester.identifier",
"path": "PermissionTicket.authorization.requester.identifier",
"short": "Requester identifiers (NPI, etc)",
"definition": "Requester identifiers (NPI, etc)",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "PermissionTicket.authorization.requester.relationship",
"path": "PermissionTicket.authorization.requester.relationship",
"short": "Relationship to subject",
"definition": "Relationship to subject",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PermissionTicket.authorization.requester.type",
"path": "PermissionTicket.authorization.requester.type",
"short": "Organization type",
"definition": "Organization type",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "PermissionTicket.authorization.requester.contained",
"path": "PermissionTicket.authorization.requester.contained",
"short": "Embedded resources",
"definition": "Embedded resources",
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
]
},
{
"id": "PermissionTicket.details",
"path": "PermissionTicket.details",
"short": "Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims.",
"definition": "Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
}
]
}
}